@title Readme
@toc   yes

@body

@h1 THIS DOCUMENT IS UNDER CONSTRUCTION

# The main installation instructions for cairolib
@h1 Installation Notes
@p+ Cairolib has several dependencies that must be obtained before any of the
libraries can be built. The following section describes the required
dependencies.
    <ul>
        <li>[[\#Setup Cairo,Cairo]]</li>
        <li>[[\#Setup SWIG,SWIG]] (to build language add-ons)</li>
        <li>[[\#Setup PHP,PHP]] (for PHP extension)</li>
    </ul>
@

# This section describes setup instructions for SWIG
@h2 Setup SWIG
@p+ First of all you'll need to install SWIG from [[http://www.swig.org]]. After 
    installing it add the SWIG executable to your path.@

@h3 Check SWIG installation
Once you're done installing verify that your SWIG installation is correct
by typing:

@code+
    swig -version
@

This should display the version information for SWIG similar to the following:

@code+
    SWIG Version 1.3.29
    
    Compiled with g++ [i686-pc-mingw32]
    Please see http://www.swig.org for reporting bugs and further information
@

@h2 Setup PHP
@p+ If you want to create the PHP extension then you must first install PHP
    and it's associated libraries. PHP may be obtained in one of two ways:
        <ul>
            <li>[[http://http://www.apachefriends.org/en/xampp.html,XAMPP]]</li>
            <li>[[http://php.net,php.net]]</li>
        </ul>@

@h2 Setup Cairo
@p+ To build any of the extensions you'll need to install [[http://www.cairographics.org, Cairo]]
    somewhere. Under Linux it is fairly easy to build on your own.@


